[BETA] Marketplace-level Forecasts

Get marketplace forecasts for the given time window.

⚠️ Beta Access Required

Contact your sales representative to gain access to this endpoint and start using it.

It returns a list of daily forecasts for the following metrics:

• Total number of auctions.
• Total number of slots.
• Total number of winners.
• Total number of impressions.
• Total number of clicks.
• Average CPC.
• Average CTR.
• Slot occupancy (Proportion of slots that are occupied).
• Total capacity (represents the potential revenue that could be generated under optimal conditions).
• Occupied capacity (reflects the actual revenue generated from effective winners and active campaigns).

GET /public/v1/toptimize/forecasting/marketplace

Try it

[BETA] Marketplace-level Forecasts

cURL

curl --request GET \
  --url https://api.topsort.com/public/v1/toptimize/forecasting/marketplace \
  --header 'Authorization: Bearer <token>'

200

[
  {
    "forecastDate": "2023-12-25",
    "metrics": [
      {
        "metricName": "<string>",
        "values": {
          "forecastValue": 123,
          "forecastIntervalMin": 123,
          "forecastIntervalMax": 123
        }
      }
    ]
  }
]

Authorizations

Authorization · string · header · required

A valid API key generated in Topsort's UI.

Query Parameters

time_window · integer · default: 7

How many days to forecast into the future.

Response

200

application/json

Successful Response

forecastDate · string<date> · required

Date of the forecast

metrics · MetricForecast · object[] · required

List of metric forecasts for this date

Show child attributes

metrics. metricName · string · required

Name of the metric being forecasted

metrics. values · ForecastMetricValue · object · required

Forecast values for this metric

Show child attributes

metrics.values. forecastValue · number · required

The forecasted value

metrics.values. forecastIntervalMin · number · required

The lower bound of the confidence interval

metrics.values. forecastIntervalMax · number · required

The upper bound of the confidence interval